Update Transaction

The Update Transaction API notifies the subscriber with transaction details when the status of a transaction is updated by the subscriber.

The response for this callback notification from the subscriber should be 200 for a successfull delivery of notification. If the response is other than 200, it is meant as failed status of notification. Hence, the notification is sent for ‘n’ number of times till getting the response as 200. If still the response is not 200, the subscription for this event will be cancelled.

Example

Payload Parameters

Parameter	Description
source Mandatory	String Source or origin of the transaction Constant value: "PL"
eventId Mandatory	String Identifier for the event associated with the transaction Sample value: "EVT1358244"
eventName Mandatory	String Name of the event Constant value: "Transaction.UPDATE"
Payload Mandatory	Object
transactionType	String Specifies the type of transaction Sample value: "DEPOSIT"
referenceID	String Unique reference ID of transaction that helps to track the transaction Sample value: "PGDEPOSITREF0000004952"
postedDate	String Date and time of the transaction was initiated Sample value: "2022-07-02T21:00:01Z"
status	String Current status of the transaction Sample value: "PENDING"
instructedAmount	Number Total amount of the transaction Sample value: 1360
instructedCurrency	String Currency of the instructed amount Sample value: "USD"
credit	Boolean Indicates whether the transaction is credit transaction Sample value: true
avalBalance	Number Balance amount in the account Sample value: 1079284
customerID	String ID of the customer account Sample value: "100000001283309"
debtorAccount	Object
reference	String Reference ID of the transaction debited from the debtor account Sample value: "txnpgdep315"
settlementAccountNumber	String Account number of the account from which the amount is debited Sample value: "100548596389492"
settlementAccountName	String Account name associated with the settlement account Sample value: "PLCBW1EFTCOLLECTIONS"
creditorAccount	Object
accountNumber	String Beneficiary account number which is credited Sample value: "200872238634465"
holderName	String Account holder name of the creditor account Sample value: "Trent Boult"
customerAccountName	String Account name associated with the customer account Sample value: "Wallet Account 1"
customerAccountType	String Type of customer account Sample value: "WALLET"
transactionNumber	String Unique number of transaction Sample value: "QA00000004568034"
channel	String Channel through which the transaction was initiated Sample value: "PG"
mode	String Mode of the transaction Sample value: "PG"
program	String Product to which the transaction is associated Sample value: "PLCBW1"
subTransactionType	String Specific type of transaction Sample value: "PG_DEPOSIT"
eftBatchID	String Unique transaction batch ID of EFT Sample value: ""
eftBatchStatus	String Current status of the batch transaction Sample value: ""
errorMsg	String Error message associated with the transaction Sample value: ""
errorCode	String Code that specifies the error message Sample value: ""
errorDescription	String Error message Sample value: ""
signature	String Signature for request validation Sample value: "signature"

Body

//Pending Transaction

{
  "source": "PL",
  "eventId": "EVT1358244",
  "eventName": "Transaction.UPDATE",
  "payload": {
    "transactionType": "DEPOSIT",
    "referenceID": "PGDEPOSITREF0000004952",
    "postedDate": "2022-07-02T21:00:01Z",
    "status": "PENDING",
    "instructedAmount": 1360,
    "instructedCurrency": "USD",
    "credit": true,
    "avalBalance": 1079284,
    "customerID": "100000001283309",
    "debtorAccount": {
      "reference": "txnpgdep315",
      "settlementAccountNumber": "100548596389492",
      "settlementAccountName": "PLCBW1EFTCOLLECTIONS"
    },
    "creditorAccount": {
      "accountNumber": "200872238634465",
      "holderName": "Trent Boult",
      "customerAccountName": "Wallet Account 1",
      "customerAccountType": "WALLET"
    },
    "transactionNumber": "QA00000004568034",
    "channel": "PG",
    "mode": "PG",
    "program": "PLCBW1",
    "subTransactionType": "PG_DEPOSIT",
    "eftBatchID": "",
    "eftBatchStatus": ""
  },
  "signature": "{{Signature}}"
}

//Completed Transaction

{
  "source": "PL",
  "eventId": "EVT1358245",
  "eventName": "Transaction.UPDATE",
  "payload": {
    "transactionType": "DEPOSIT",
    "referenceID": "PGDEPOSITREF0000004952",
    "postedDate": "2022-07-02T21:00:01Z",
    "status": "COMPLETED",
    "instructedAmount": 1360,
    "instructedCurrency": "USD",
    "credit": true,
    "avalBalance": 1079284,
    "customerID": "100000001283309",
    "debtorAccount": {
      "reference": "txnpgdep315",
      "settlementAccountNumber": "100548596389492",
      "settlementAccountName": "PLCBW1EFTCOLLECTIONS"
    },
    "creditorAccount": {
      "accountNumber": "200872238634465",
      "holderName": "Trent Boult",
      "customerAccountName": "Wallet Account 1",
      "customerAccountType": "WALLET"
    },
    "transactionNumber": "QA00000004568034",
    "eftBatchID": "",
    "eftBatchStatus": ""
  },
  "signature": "{{Signature}}"
}

//Failed Transaction

{
  "source": "PL",
  "eventId": "EVT1358246",
  "eventName": "Transaction.UPDATE",
  "payload": {
    "transactionType": "DEPOSIT",
    "referenceID": "PGDEPOSITREF0000004952",
    "postedDate": "2022-07-02T21:00:01Z",
    "status": "FAILED",
    "instructedAmount": 1360,
    "instructedCurrency": "USD",
    "credit": true,
    "avalBalance": 1079284,
    "customerID": "100000001283309",
    "debtorAccount": {
      "reference": "txnpgdep315",
      "settlementAccountNumber": "100548596389492",
      "settlementAccountName": "PLCBW1EFTCOLLECTIONS"
    },
    "creditorAccount": {
      "accountNumber": "200872238634465",
      "holderName": "Trent Boult",
      "customerAccountName": "Wallet Account 1",
      "customerAccountType": "WALLET"
    },
    "transactionNumber": "QA00000004568034",
    "eftBatchID": "",
    "eftBatchStatus": "",
    "errorCode": "",
    "errorDescription": ""
  },
  "signature": "{{Signature}}"
}

Response: 200

{
  //The response for this callback notification from the subscriber should be 200 for a successfull delivery of notification. If the response is other than 200, it is meant as failed status of notification. Hence, the notification is sent for ‘n’ number of times till getting the response as 200. If still the response is not 200, the subscription for this event will be cancelled.
}